home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / CONVERTR / MHONARC / README.TXT < prev    next >
Encoding:
Text File  |  1995-04-18  |  6.1 KB  |  156 lines
  1. README.DOS for MHonArc
  2.  
  3. ---------------------------------------------------------------------------
  4. Table of Contents:
  5.     CONTENTS
  6.     DOCUMENTATION
  7.     INSTALLATION
  8.     BUGS/COMMENTS/SUGGESTIONS?
  9.  
  10. ---------------------------------------------------------------------------
  11.     MHonArc -- Internet mail-to-HTML converter
  12.     Copyright (C) 1995    Earl Hood, ehood@convex.com
  13.  
  14.     This program is free software; you can redistribute it and/or modify
  15.     it under the terms of the GNU General Public License as published by
  16.     the Free Software Foundation; either version 2 of the License, or
  17.     (at your option) any later version.
  18.  
  19.     This program is distributed in the hope that it will be useful,
  20.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  21.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22.     GNU General Public License for more details.
  23.  
  24.     You should have received a copy of the GNU General Public License
  25.     along with this program; if not, write to the Free Software
  26.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  27. ---------------------------------------------------------------------------
  28. Notes to MS-DOS users:
  29.  
  30.     1. IMPORTANT: You must preserve the subdirectory structure of the
  31.     .zip archive when unzipping MHonArc.  Use the -d option if you are
  32.     using pkunzip.
  33.  
  34.     2. All text files included in the distrubution (excluding files in the
  35.     `bat' directory and this file) are in Unix format. I.e. Newlines
  36.     are used to terminate end-of-lines.  MS-DOS text files use
  37.     return/newline pairs.  Any text files that get installed via the
  38.     `install.me' script will automatically get converted to DOS
  39.     format.
  40.  
  41.     If you want to convert any other text file to MS-DOS style, the
  42.     following one-line Perl script will do:
  43.  
  44.     perl -e "print <>;" text.unx >text.dos
  45.  
  46.     3. File names mentioned in the MHonArc documentation are in Unix
  47.     format.  DOS names differ slightly.  To translate mentally,
  48.     first substitute \ for /.  Then, within each directory component
  49.     and the file name, ignore any characters beyond the eighth before
  50.     a dot and ignore any characters beyond the third after a dot.
  51.  
  52. ---------------------------------------------------------------------------
  53. CONTENTS
  54.  
  55. ACKNOWLG      Thanks to people
  56. CHANGES          Revision history of MHonArc
  57. COPYING          GNU General Public License
  58. README          Unix equivalent of README.DOS
  59. README.DOS      The file you are reading
  60. RELNOTES      Release notes for MHonArc (*READ*)
  61. TODO          MHonArc "to do" list
  62. bat/          Batch files for MS-DOS users
  63. doc/          Documentation for MHonArc
  64. examples/      Example resource files for MHonArc
  65. extras/          Extra programs for use with MHonArc (See extras/README)
  66. install.me      Installation program for MHonArc
  67. lib/          Libraries/MIME filters used by MHonArc
  68. logo/          Gifs of the MHonArc logo
  69. mhonarc*      The MHonArc Perl program
  70.  
  71. ---------------------------------------------------------------------------
  72. ** PLEASE read RELNOTES before running MHonArc.
  73. ---------------------------------------------------------------------------
  74. ---------------------------------------------------------------------------
  75. DOCUMENTATION
  76.  
  77. Documentation for MHonArc is located in the doc/ directory.
  78.  
  79. html:
  80.     The main documentation for MHonArc is in multiple HTML files.  Load
  81.     mhonarc.html in the doc/ directory into your Web browser to get
  82.     started.
  83.  
  84. ascii:
  85.     A plain text version of the documentation is in the single file
  86.     mhonarc.txt.  This file is created by converting the HTML files
  87.     into ascii.  See the Makefile in doc/ for how the conversion is
  88.     done.
  89.  
  90. manpage:
  91.     For Unix users, there is a manpage in doc/ called mhonarc.1.  It
  92.     is not very fancy.  It is automatically generated like the
  93.     ascii version.  The manpage does not follow the standard manpage
  94.     style and is not intended to be printed via troff.
  95.  
  96.     The installation process does not deal with the manpage.  If you
  97.     want to install it, you must do it manually.  The installation
  98.     process does allow you to install the HTML documentation in a
  99.     location of your choice.
  100.  
  101. ---------------------------------------------------------------------------
  102. INSTALLATION
  103.  
  104. The documentation contains a section on installing MHonArc for Unix
  105. and MS-DOS machines.  I recommend reading the Installation section as
  106. it contains more information then what is included here.
  107.  
  108. Brief Instructions
  109.  
  110.     To install MHonArc, run the following command:
  111.  
  112.     % perl install.me
  113.  
  114.     The installation process will ask you a series of questions on
  115.     where the Perl executable is and where to put MHonArc files.  Just
  116.     hit <CR> to accept the default values listed in ()'s.
  117.  
  118.     Notes on installation process:
  119.  
  120.     o The '#!' line in the installed mhonarc program is set to
  121.       point to the Perl executable specified in the installation
  122.       process (this has no meaning under MS-DOS).
  123.  
  124.     o The installed mhonarc program has code added so it will find
  125.       its default libraries specified in the installation program.
  126.       I.e.  The install lib directory is added to mhonarc's search
  127.       path so it will find its libraries.
  128.  
  129.     o If you specify paths that do not exist, the install.me
  130.       program will create the path.
  131.  
  132.  
  133. ** PLEASE read RELNOTES before running MHonArc.
  134.  
  135. ---------------------------------------------------------------------------
  136. BUGS/COMMENTS/SUGGESTIONS?
  137.  
  138.     If you have any bugs/comments/suggestions about MHonArc, check the
  139.     Contacts section of the documentation for the proper person to
  140.     contact.
  141.  
  142.     If it is a bug you are reporting, please include the following in
  143.     your message:
  144.  
  145.         o  Version of Perl (can be retrievied by "perl -v").
  146.         o  Version of the program in question.
  147.         o  The exact command-line used to invoke the program.
  148.         o  Error/diagnostic messages from the program.
  149.         o  Any other information that might prove useful.
  150.  
  151.     Before sending e-mail, make sure the documentation does not already
  152.     have an answer to your question/problem.
  153.  
  154. ---------------------------------------------------------------------------
  155. Earl Hood, ehood@convex.com
  156.